Class: AutoretrieveApi
AutoretrieveApi - object-oriented interface
Export
Hierarchy
↳
AutoretrieveApi
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new AutoretrieveApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
adminAutoretrieveInitPost
▸ adminAutoretrieveInitPost(addresses, pubKey, options?): Promise<Response>
This endpoint registers a new autoretrieve server
Summary
Register autoretrieve server
Throws
Memberof
AutoretrieveApi
Parameters
| Name | Type | Description |
|---|---|---|
addresses | string | Autoretrieve's comma-separated list of addresses |
pubKey | string | Autoretrieve's public key |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1256
adminAutoretrieveListGet
▸ adminAutoretrieveListGet(options?): Promise<Response>
This endpoint lists all registered autoretrieve servers
Summary
List autoretrieve servers
Throws
Memberof
AutoretrieveApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1267
autoretrieveHeartbeatPost
▸ autoretrieveHeartbeatPost(token, options?): Promise<Response>
This endpoint updates the lastConnection field for autoretrieve
Summary
Marks autoretrieve server as up
Throws
Memberof
AutoretrieveApi
Parameters
| Name | Type | Description |
|---|---|---|
token | string | Autoretrieve's auth token |
options? | any | Override http request option. |
Returns
Promise<Response>